GET Reporting/v1/Stock/GetCompanyStockPeriodSummary?SiteIDs[0]={SiteIDs[0]}&SiteIDs[1]={SiteIDs[1]}&periodEndDate={periodEndDate}
Gets the Company Stock Period Summary report data for given sites and period date.
Request Information
URI Parameters
| Name | Type | Description | Additional information |
|---|---|---|---|
| SiteIDs | Collection of integer |
Required: SiteIDs which the report will be run for |
|
| periodEndDate | date |
Required: End Date on the requested Stock Period |
Body Parameters
None.
Response Information
Resource Description
Collection of CompanyStockPeriodSummaryReportItemDto| Name | Type | Description | Additional information |
|---|---|---|---|
| SiteID | integer |
None. |
|
| StockPeriodID | integer |
None. |
|
| SiteName | string |
None. |
|
| StartDateUtc | date |
None. |
|
| EndDateUtc | date |
None. |
|
| LocalTimeZoneID | string |
None. |
|
| ProductTypeID | integer |
None. |
|
| ProductType | string |
None. |
|
| OpeningNetStockValue | decimal number |
None. |
|
| ClosingNetStockValue | decimal number |
None. |
|
| NetDeliverySubtotal | decimal number |
None. |
|
| NetInboundSiteTransfers | decimal number |
None. |
|
| NetOutboundSiteTransfers | decimal number |
None. |
|
| NetConsumptionValue | decimal number |
None. |
|
| RetailVarianceValue | decimal number |
None. |
|
| NetSales | decimal number |
None. |
|
| ExpNetSales | decimal number |
None. |
|
| NetCostOfSales | decimal number |
None. |
|
| NetCostOfWastage | decimal number |
None. |
|
| NetCostOfAutoUsage | decimal number |
None. |
|
| NetCreditSubtotal | decimal number |
None. |
|
| NetStockVarianceValue | decimal number |
None. |
|
| Rebate | decimal number |
None. |
|
| EposNetSales | decimal number |
None. |
|
| EposNetCostOfSales | decimal number |
None. |
|
| PotentialSalesMargin | decimal number |
None. |
|
| PotentialSalesGPPercentage | decimal number |
None. |
|
| BeforeDiscountSalesMargin | decimal number |
None. |
|
| BeforeDiscountSalesGPPercentage | decimal number |
None. |
|
| AfterDiscountSalesMargin | decimal number |
None. |
|
| AfterDiscountSalesGPPercentage | decimal number |
None. |
|
| ActualSalesMargin | decimal number |
None. |
|
| ActualSalesGPPercentage | decimal number |
None. |
|
| CostOfSalesMargin | decimal number |
None. |
|
| CostOfSalesGPPercentage | decimal number |
None. |
|
| EposSalesMargin | decimal number |
None. |
|
| NetCostOfGoods | decimal number |
None. |
|
| CostOfGoodsEposSalesPercentage | decimal number |
None. |
|
| StartDate | date |
None. |
|
| EndDate | date |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
application/xml, text/xml
Sample:
<ArrayOfCompanyStockPeriodSummaryReportItemDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.StockMid.Core.Models.StockPeriods.Dto">
<CompanyStockPeriodSummaryReportItemDto>
<_x003C_ClosingNetStockValue_x003E_k__BackingField>10</_x003C_ClosingNetStockValue_x003E_k__BackingField>
<_x003C_EndDateUtc_x003E_k__BackingField>2024-11-21T06:26:26.1659654+00:00</_x003C_EndDateUtc_x003E_k__BackingField>
<_x003C_EposNetCostOfSales_x003E_k__BackingField>25</_x003C_EposNetCostOfSales_x003E_k__BackingField>
<_x003C_EposNetSales_x003E_k__BackingField>24</_x003C_EposNetSales_x003E_k__BackingField>
<_x003C_ExpNetSales_x003E_k__BackingField>17</_x003C_ExpNetSales_x003E_k__BackingField>
<_x003C_LocalTimeZoneID_x003E_k__BackingField>sample string 6</_x003C_LocalTimeZoneID_x003E_k__BackingField>
<_x003C_NetConsumptionValue_x003E_k__BackingField>14</_x003C_NetConsumptionValue_x003E_k__BackingField>
<_x003C_NetCostOfAutoUsage_x003E_k__BackingField>20</_x003C_NetCostOfAutoUsage_x003E_k__BackingField>
<_x003C_NetCostOfSales_x003E_k__BackingField>18</_x003C_NetCostOfSales_x003E_k__BackingField>
<_x003C_NetCostOfWastage_x003E_k__BackingField>19</_x003C_NetCostOfWastage_x003E_k__BackingField>
<_x003C_NetCreditSubtotal_x003E_k__BackingField>21</_x003C_NetCreditSubtotal_x003E_k__BackingField>
<_x003C_NetDeliverySubtotal_x003E_k__BackingField>11</_x003C_NetDeliverySubtotal_x003E_k__BackingField>
<_x003C_NetInboundSiteTransfers_x003E_k__BackingField>12</_x003C_NetInboundSiteTransfers_x003E_k__BackingField>
<_x003C_NetOutboundSiteTransfers_x003E_k__BackingField>13</_x003C_NetOutboundSiteTransfers_x003E_k__BackingField>
<_x003C_NetSales_x003E_k__BackingField>16</_x003C_NetSales_x003E_k__BackingField>
<_x003C_NetStockVarianceValue_x003E_k__BackingField>22</_x003C_NetStockVarianceValue_x003E_k__BackingField>
<_x003C_OpeningNetStockValue_x003E_k__BackingField>9</_x003C_OpeningNetStockValue_x003E_k__BackingField>
<_x003C_ProductTypeID_x003E_k__BackingField>7</_x003C_ProductTypeID_x003E_k__BackingField>
<_x003C_ProductType_x003E_k__BackingField>sample string 8</_x003C_ProductType_x003E_k__BackingField>
<_x003C_Rebate_x003E_k__BackingField>23</_x003C_Rebate_x003E_k__BackingField>
<_x003C_RetailVarianceValue_x003E_k__BackingField>15</_x003C_RetailVarianceValue_x003E_k__BackingField>
<_x003C_SiteID_x003E_k__BackingField>1</_x003C_SiteID_x003E_k__BackingField>
<_x003C_SiteName_x003E_k__BackingField>sample string 3</_x003C_SiteName_x003E_k__BackingField>
<_x003C_StartDateUtc_x003E_k__BackingField>2024-11-21T06:26:26.1659654+00:00</_x003C_StartDateUtc_x003E_k__BackingField>
<_x003C_StockPeriodID_x003E_k__BackingField>2</_x003C_StockPeriodID_x003E_k__BackingField>
</CompanyStockPeriodSummaryReportItemDto>
<CompanyStockPeriodSummaryReportItemDto>
<_x003C_ClosingNetStockValue_x003E_k__BackingField>10</_x003C_ClosingNetStockValue_x003E_k__BackingField>
<_x003C_EndDateUtc_x003E_k__BackingField>2024-11-21T06:26:26.1659654+00:00</_x003C_EndDateUtc_x003E_k__BackingField>
<_x003C_EposNetCostOfSales_x003E_k__BackingField>25</_x003C_EposNetCostOfSales_x003E_k__BackingField>
<_x003C_EposNetSales_x003E_k__BackingField>24</_x003C_EposNetSales_x003E_k__BackingField>
<_x003C_ExpNetSales_x003E_k__BackingField>17</_x003C_ExpNetSales_x003E_k__BackingField>
<_x003C_LocalTimeZoneID_x003E_k__BackingField>sample string 6</_x003C_LocalTimeZoneID_x003E_k__BackingField>
<_x003C_NetConsumptionValue_x003E_k__BackingField>14</_x003C_NetConsumptionValue_x003E_k__BackingField>
<_x003C_NetCostOfAutoUsage_x003E_k__BackingField>20</_x003C_NetCostOfAutoUsage_x003E_k__BackingField>
<_x003C_NetCostOfSales_x003E_k__BackingField>18</_x003C_NetCostOfSales_x003E_k__BackingField>
<_x003C_NetCostOfWastage_x003E_k__BackingField>19</_x003C_NetCostOfWastage_x003E_k__BackingField>
<_x003C_NetCreditSubtotal_x003E_k__BackingField>21</_x003C_NetCreditSubtotal_x003E_k__BackingField>
<_x003C_NetDeliverySubtotal_x003E_k__BackingField>11</_x003C_NetDeliverySubtotal_x003E_k__BackingField>
<_x003C_NetInboundSiteTransfers_x003E_k__BackingField>12</_x003C_NetInboundSiteTransfers_x003E_k__BackingField>
<_x003C_NetOutboundSiteTransfers_x003E_k__BackingField>13</_x003C_NetOutboundSiteTransfers_x003E_k__BackingField>
<_x003C_NetSales_x003E_k__BackingField>16</_x003C_NetSales_x003E_k__BackingField>
<_x003C_NetStockVarianceValue_x003E_k__BackingField>22</_x003C_NetStockVarianceValue_x003E_k__BackingField>
<_x003C_OpeningNetStockValue_x003E_k__BackingField>9</_x003C_OpeningNetStockValue_x003E_k__BackingField>
<_x003C_ProductTypeID_x003E_k__BackingField>7</_x003C_ProductTypeID_x003E_k__BackingField>
<_x003C_ProductType_x003E_k__BackingField>sample string 8</_x003C_ProductType_x003E_k__BackingField>
<_x003C_Rebate_x003E_k__BackingField>23</_x003C_Rebate_x003E_k__BackingField>
<_x003C_RetailVarianceValue_x003E_k__BackingField>15</_x003C_RetailVarianceValue_x003E_k__BackingField>
<_x003C_SiteID_x003E_k__BackingField>1</_x003C_SiteID_x003E_k__BackingField>
<_x003C_SiteName_x003E_k__BackingField>sample string 3</_x003C_SiteName_x003E_k__BackingField>
<_x003C_StartDateUtc_x003E_k__BackingField>2024-11-21T06:26:26.1659654+00:00</_x003C_StartDateUtc_x003E_k__BackingField>
<_x003C_StockPeriodID_x003E_k__BackingField>2</_x003C_StockPeriodID_x003E_k__BackingField>
</CompanyStockPeriodSummaryReportItemDto>
</ArrayOfCompanyStockPeriodSummaryReportItemDto>